Repository navigation
feat: migrate the site from Honkit to VitePress - #40
Merged
Merged
Conversation
Build the book with VitePress 2 (alpha) instead of Honkit: - sidebar generated from each locale's SUMMARY.md; SUMMARY.md also renders as a table-of-contents page, fixing the links that 404'd - Honkit-compatible heading ids and the same .html URLs - Mermaid rendered at build time to light/dark SVG images - SEO head tags via transformHead and the built-in sitemap - built-in local search per locale; PDF output dropped Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Replace the build-time Playwright renderer, which hung the CI build, with mokevnin/vitepress-mermaid: diagrams are drawn in the browser and redrawn on a theme toggle. The book palette and its dark variant are passed as getters, so each render picks the palette for the current mode. Playwright and mermaid-isomorphic are no longer dependencies. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Moves the book from Honkit to VitePress 2 (alpha).
What changes
SUMMARY.md, which also renders as a table-of-contents page. That fixes the "table of contents" links on the locale home pages and in "How to read", which 404'd under Honkit..htmlURLs and Honkit-compatible heading ids, so existing links and section anchors keep working.book/.vitepress/mermaid.mjs). They are<img>tags because Vue strips the<style>inside an inline SVG, so diagram text is no longer selectable.transformHead(book/.vitepress/seo.mjs); the sitemap is VitePress's own, with x-default added.mise run check.Verification
Compared against a Honkit build of
main:\<placeholder\>text;Every diagram type was checked in light and dark mode, plus the mobile layout and the dev server.
🤖 Generated with Claude Code